Skip to content

docs: host migration behaviour with disable-migration flag#184

Open
H-M-Quang-Ngo wants to merge 2 commits intocanonical:mainfrom
H-M-Quang-Ngo:add-doc-for-host-migration-behavior
Open

docs: host migration behaviour with disable-migration flag#184
H-M-Quang-Ngo wants to merge 2 commits intocanonical:mainfrom
H-M-Quang-Ngo:add-doc-for-host-migration-behavior

Conversation

@H-M-Quang-Ngo
Copy link
Copy Markdown

Update the documentation for using the disable-migration flag in host maintenance operation, based on canonical/snap-openstack#724

@H-M-Quang-Ngo H-M-Quang-Ngo marked this pull request as draft March 24, 2026 06:55
@H-M-Quang-Ngo H-M-Quang-Ngo force-pushed the add-doc-for-host-migration-behavior branch from c68c0d7 to 069cecf Compare March 24, 2026 07:00
@H-M-Quang-Ngo H-M-Quang-Ngo marked this pull request as ready for review March 24, 2026 07:04
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

By default, enabling maintenance mode will live migrate active instances and cold
migrate inactive instances. The ``--disable-migration`` flag allows operators to
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The option should also be provided in Usage section

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @hemanthnakkina , thanks for the review!

I'm a bit confused here, because it is already in Usage section. The hierarchy is Usage -> Enabling Maintenance Mode -> Controlling migration behavior

I intentionally placed it after the basic enable flow so the simple happy path is provided first, with the optional flag documented as a follow-up. Do you think this structure works, or would you prefer something different?

I attach this image for clearer visualization:

image

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean [ --disable-migration ] should be specified as optional parameter in commands during --dry-run since the output varies based on the this flag

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hemanthnakkina , thanks, I added in ed9546c

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants